MkBlockQuote

Show source on GitHub

BlockQuote node.

ExamplesDocStringsBase classes⋔ Inheritance diagramNodeFileCode

Example: Regular

Jinja

{{ "Some text" | MkBlockQuote }}

Python

MkBlockQuote('Some text')

RenderedMarkdownHtmlreSTRepr tree

Some text

> Some text

<blockquote>
<p>Some text</p>
</blockquote>

    Some text

MkBlockQuote
╰── MkText('Some text')

Example: Nested

Jinja

{{ "Nested!" | MkBlockQuote | MkBlockQuote }}

Python

MkContainer([...])

RenderedMarkdownHtmlRepr tree

Nested!

Nested!

> Nested!


> > Nested!

<blockquote>
<p>Nested!</p>
<blockquote>
<p>Nested!</p>
</blockquote>
</blockquote>

MkContainer
├── MkBlockQuote('Nested!')
│   ╰── MkText('Nested!')
╰── MkBlockQuote([list([...])])
├── MkBlockQuote('Nested!')
│   ╰── MkText('Nested!')

Bases: MkContainer

Name	Children	Inherits
MkContainer mknodes.basenodes.mkcontainer A node containing other MkNodes.	MkBlock MkAdmonition MkBlockQuote MkCode MkTemplate MkList MkBaseTable MkTab MkTabContainer MkCritic MkAnnotation ...	MkNode

graph TD
  94420313240704["mkblockquote.MkBlockQuote"]
  94420312299136["mkcontainer.MkContainer"]
  94420313076768["mknode.MkNode"]
  94420313236736["node.Node"]
  140608527347936["builtins.object"]
  94420312299136 --> 94420313240704
  94420313076768 --> 94420312299136
  94420313236736 --> 94420313076768
  140608527347936 --> 94420313236736

/home/runner/work/mknodes/mknodes/mknodes/basenodes/mkblockquote/metadata.toml

[metadata]
icon = "mdi:format-quote-open"
name = "MkBlockQuote"

[examples.regular]
title = "Regular"
jinja = """
{{ "Some text" | MkBlockQuote }}
"""

[examples.nested]
title = "Nested"
description = "We can also nest blocks, they will adjust their delimiters automatically."
jinja = """
{{ "Nested!" | MkBlockQuote | MkBlockQuote }}
"""

[output.markdown]
template = """
{{ node.items | join(node.block_separator) | indent(width="> ", first=True) | rstrip("\n") }}

"""

# [output.html]
# template = """
# <blockquote>
# {{ node.items | join(node.block_separator)  }}
# </blockquote>
# """

[output.rst]
template = """
{{ node.items | join(node.block_separator) | indent(width="    ", first=True) | rstrip("\n") }}

"""

class MkBlockQuote(mkcontainer.MkContainer):
    """BlockQuote node."""

    ICON = "material/format-quote-open"
    STATUS = "new"

    def _to_markdown(self) -> str:
        text = super()._to_markdown()
        return textwrap.indent(text, "> ").rstrip("\n") + "\n"